home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr37 / ripit_10.zip / RIP_IT.DOC < prev    next >
Text File  |  1995-03-28  |  18KB  |  344 lines
  1. ┌───────────────────────────────────────────────────────────────────────────┐ 
  2. │                  Copyright Notice and Program Disclaimer                  │ 
  3. └───────────────────────────────────────────────────────────────────────────┘
  4.  
  5.     The program RIP_IT.EXE its support files, and this documentation file, 
  6.     are Copyright 1995, G.A.C. Computer Services.  Distribution & execution 
  7.     of the original, unaltered version is permitted, and encouraged, as long 
  8.     as all support files and documentation that accompany the program are 
  9.     included without modification in any form.
  10.  
  11.     DISCLAIMER:
  12.  
  13.     I (Gregory Campbell) make no warranty of any kind, expressed or implied,  
  14.     including without limitation any warranties of merchantability
  15.     and/or fitness for a particular purpose.  I shall not be held liable      
  16.     for any damages, whether direct, indirect, special or consequential       
  17.     arising from the failure of this program to operate in the manner desired 
  18.     by the user.  I shall not be held liable for any damage to data or        
  19.     property which may be caused directly or indirectly by the use of this    
  20.     program.
  21.  
  22.     In no event will I be held liable for any damages, including (but
  23.     not limited to) any lost profits, lost savings, or other incidental       
  24.     or consequential damages arising out of the use -- or the inability       
  25.     to use -- this program, or for any claim by any other party.
  26.  
  27. ┌───────────────────────────────────────────────────────────────────────────┐ 
  28. │             List of included files in the RIP It! Archive                 │ 
  29. └───────────────────────────────────────────────────────────────────────────┘
  30.  
  31.     RIP_IT.EXE   - The Main executable
  32.     RIP_IT.DOC   - This Documentation file
  33.     RIP_IT.CFG   - The RIP It! Configuration file (one of many files
  34.             that allow you to customize RIP It!.  Be sure to
  35.             at least look over the customizing section.)
  36.     FILE_ID.DIZ  - A short description of RIP It!
  37.     REGISTER.DOC - A Registration form for G.A.C. Computer Services 
  38.             Products.
  39.     FILENAME.CLR - Color config files for RIP It! menus
  40.     
  41.     BACKGRND.RIP - A sample of the default RIP background (Not Used)
  42.     HEADER.ASC   - An example of the default ASC header file (Not Used)
  43.  
  44. ┌───────────────────────────────────────────────────────────────────────────┐ 
  45. │                   What RIP It! does and how to use it!                    │ 
  46. └───────────────────────────────────────────────────────────────────────────┘
  47.  
  48.     NOTE: THIS PROGRAM SHOULD ONLY BE USED WITH SYNCHRONET 2.0 AND UP!
  49.  
  50.     RIP It! is a utility designed to make the "Optional Menu Files" in both
  51.     RIP and Synchronet Ctrl-A code format (.ASC) for the Synchronet BBS 
  52.     system easily and most importantly quickly!  RIP It! reads all 
  53.     information for creating these menus directly from the Synchronet 
  54.     configuration files (*.CNF) found in the control directory (usually 
  55.     C:\SBBS\CTRL\).  RIP It! then creates the following files in the 
  56.     directory you specify in RIP_IT.CFG (usually C:\SBBS\TEXT\MENU\).
  57.  
  58.     GRPS.RIP  & GRPS.ASC        - Message Group Listing
  59.     SUBSx.RIP & SUBSx.ASC       - Message sub-board listing, x is the 
  60.                   sub-board number
  61.  
  62.     NOTE: The following menus are only created in the registered version
  63.  
  64.     LIBS.RIP  & LIBS.ASC        - File library listing
  65.     DIRSx.RIP & DIRSx.ASC       - File directory listing, x is the library 
  66.                   number
  67.     XTRN_SEC.RIP & XTRN_SEC.ASC - External program sections
  68.     XTRNx.RIP & XTRNx.ASC       - External program listing, x is section
  69.                   number
  70.     TEXT_SEC.RIP & TEXT_SEC.ASC - Text file section listing
  71.     TEXTx.RIP & TEXTx.ASC       - Text file listing, x is the section number
  72.  
  73.     NOTE: These menu descriptions were taken from the Synchronet 2.00 g
  74.       SysOp Manual Page 228 
  75.     
  76.     
  77.     As you can see from the list of created menus above, RIP It! does an
  78.     immense amount of work in minutes that would normally take a SysOp
  79.     literally hundreds of hours to accomplish (trust me, I tried to create
  80.     all of these menus manually for my BBS).  The best part about RIP It!
  81.     is that you can re-create the menus in another few minutes and you do
  82.     not have to manually edit all of the menus every time you add or delete
  83.     an item in your Synchronet Configuration!
  84.  
  85.     RIP It! has been designed to allow the SysOp a large degree of 
  86.     customizing including custom colors for both the ASC and RIP menus,
  87.     the use of custom backgrounds (RIP) and headers (ASC) [Registered
  88.     version only], ability to configure menu titles and prefixes and the 
  89.     ability to force minimum column output in RIP to allow more room at 
  90.     the bottom of each menu for your custom backgrounds.
  91.  
  92.     In all there are 25 different files that you may configure for
  93.     customizing, but only if you want to.  The defaults look very
  94.     impressive.
  95.  
  96.     RIP It! is limited in the number of items that can be fully displayed on 
  97.     each menu due to the constraints of the RIP screen and fonts.  Currently 
  98.     RIP It! will produce a single column of menu items if there are 23 or 
  99.     less items on that menu, and it will place up to 46 items on one menu 
  100.     using two columns and a slightly smaller font.  
  101.     
  102.     If your system is configred with more than 46 items on each menu you can 
  103.     still use RIP It!, but the menu item descriptions for those areas will be 
  104.     truncated so that more items will fit.  RIP It! supports up to four
  105.     columns of 23 items (or 92 items on a menu).  If you have more than 92
  106.     items per menu, then you are extremely limited to what you can display
  107.     on the RIP screen and your users probably hate it anyway. 8-)
  108.  
  109.     You may force RIP It! to create menus with a minimum number of columns
  110.     by replacing 1 in the RIP_IT.CFG with a number from 1 to 4, for one to
  111.     four columns respectively.  
  112.  
  113.     NOTE: Since the text file descriptions can be much longer than other
  114.     descriptions, RIP It! will start the text file descriptions on the far
  115.     left of all TEXTx.RIP screens.  This way you can use the longer 
  116.     descriptions that Synchronet allows.
  117.  
  118.     The following chart shows the number of columns, items, and characters
  119.     displayed on the menu.
  120.  
  121.     | COL | # Items |          # Characters Displayed            |
  122.     --------------------------------------------------------------
  123.     |  1  |    23   | all 40 for each item (71 for TEXTx.RIPs)   |
  124.     |  2  |    46   | all 40 for each item (48 for TEXTx.RIPs)   |
  125.     |  3  |    69   | First 30 of each item                      |    
  126.     |  4  |    92   | First 20 of each item                      |
  127.     --------------------------------------------------------------
  128.  
  129.     *********************   VERY IMPORTANT NOTE   **************************
  130.     
  131.     There is one thing that needs to be made perfectly clear before you 
  132.     continue.  Synchronet does not allow you to specify multiple menus for
  133.     an area based on user security level, therefore RIP It! doesn't support
  134.     security levels and probably never will.  Unless Synchronet will support
  135.     the option to display different menus to different security levels
  136.     internally (not through BAJA).
  137.  
  138.     What this means is that RIP It! will place EVERY ITEM on the menu it 
  139.     creates in the order they are found in SCFG!  This means that you must
  140.     either allow all users to ACCESS ALL areas appearing on that menu, or you
  141.     must move the higher access levels to the BOTTOM in SCFG.  This way
  142.     a user that doesn't have access to an area will still be able to access
  143.     the lower numbered areas correctly.  This applies to all message, file,
  144.     external program and text areas.  
  145.     
  146.     This sounds like a real drawback, but it is easy to remedy.  I personally
  147.     allow all users to ACCESS all areas of the BBS whether they are paying
  148.     members or not.  Then I limit the non-paying users by placing 
  149.     restrictions on READING and POSTING to a Message Base, EXECUTING External
  150.     programs, and DOWNLOADING and UPLOADING to file areas.  This way EVERY
  151.     user sees the same menus, but only the paying members can do anything in
  152.     certain areas.  
  153.     
  154.     To avoid user confusion, I designated the paying areas by placing a 
  155.     dollar sign, $, at the front of each area description limited to paying 
  156.     members, and an asterick, *, at the front of each area limited to SysOps.  
  157.     This has actually increased my paying members since they realize 
  158.     immediately what contributing to the BBS gains them.
  159.  
  160.     Of course it takes less time to reconfigure the access levels then it 
  161.     does to create even a couple of RIP and ASC menus.  Best of all, after
  162.     you configure the areas once, you are set to use RIP It! anytime you
  163.     add or delete areas of your BBS!  And to top it all off, my users LOVE
  164.     the RIP menus that are created with RIP It! and are convinced that it
  165.     is worth every penny.
  166.  
  167.     
  168.     Now that you have been warned about access levels, the following will
  169.     explain how to get RIP It! running.  It should only take you a few
  170.     minutes.  NOTE: An ANSI driver is not required for RIP It! to operate
  171.     correctly, but you won't be able to see the colors while RIP It! is 
  172.     running.
  173.  
  174.     To set up RIP It! follow the instructions given below.  
  175.  
  176.     1. Create a directory for RIP It!
  177.         e.g. mkdir c:\sbbs\xtrn\rip_it <ENTER>
  178.  
  179.     2. Copy ALL of the archive files to this directory.
  180.         e.g. copy *.* c:\sbbs\xtrn\rip_it <ENTER>
  181.  
  182.     3. Edit the RIP_IT.CFG file to point to the correct directories,
  183.         enter your name and BBS name (these should be the same as 
  184.         in SCFG), and alter the default titles.
  185.  
  186.     NOTE: RIP It! expects the CTRL and DATA\TEXT directories to be 
  187.     under the directory you specify for SBBS (e.g. C:\SBBS\).
  188.  
  189.     4. You may also edit the colors for the menus in the MSGGRP.CLR 
  190.         and SUBLIST.CLR files if you don't like the defaults.
  191.  
  192.     NOTE: You may specify any directory where you want the menu files
  193.     created.  RIP It! will OVERWRITE ALL ASC and RIP optional menus in
  194.     the directory you specify in RIP_IT.CFG.  Therefore, if you have
  195.     already created some custom ASC and RIP menus be sure to back them 
  196.     up or point to a directory other than C:\SBBS\TEXT\MENU\.
  197.  
  198.     5. Now that you are ready, simply type RIP_IT from the RIP It! 
  199.         directory and ALL of the "Optional Menus" will be created.
  200.         
  201.     NOTE: Be sure to see the Customizing RIP It! and the
  202.           DEMO Restrictions sections below. 
  203.  
  204. ┌───────────────────────────────────────────────────────────────────────────┐
  205. │                           Customizing RIP It!                             │
  206. └───────────────────────────────────────────────────────────────────────────┘
  207.  
  208.      OK, now that you have installed RIP It! and have your BBS configured
  209.      to work correctly with the RIP It! created menus you probably want
  210.      to know how you can customize the menus so they don't look like every
  211.      other Synchronet BBS that is running RIP It!
  212.  
  213.      The easiest thing to do is change the colors in the various 
  214.      FILENAME.CLR files.  See below for custom file descriptions.
  215.      You can specify seperate colors for the ASC and RIP menus.  The 
  216.      configuration file contains all the details on color customizing.
  217.  
  218.      You can also specify what you want the Titles to be in the RIP_IT.CFG 
  219.      file.  For example, the default is Program Sections for the
  220.      External Program Sections Title, but I prefer to use On-Line Game
  221.      Areas on my BBS.  Just be sure to keep each prefix under 25 characters
  222.      or smaller if you have long descriptions and keep the titles under 60
  223.      characters.
  224.  
  225.      You can also customize RIP It! by creating any or all of the following
  226.      files.  RIP It! will check for each files existence and if RIP It! finds
  227.      any of the files in its directory they will be used in place of the 
  228.      default RIP backgrounds and ASC headers.
  229.  
  230.      NOTE: You may see what the default backgrounds and headers look like by 
  231.        viewing the HEADER.ASC and BACKGRND.RIP files that came with 
  232.        RIP It!.  These files are hard coded into RIP It! for use as the
  233.        defaults.
  234.  
  235.      MSGGRP.RIP   - This is the background for the RIP Message Groups Listing
  236.      MSGGRP.ASC   - This is the header for the ASC Message Groups Listing
  237.      MSGGRP.CLR   - This is the color config for Message Groups Listing
  238.      
  239.      SUBLIST.RIP  - This is the background for the RIP Sub-Board Listings
  240.      SUBLIST.ASC  - This is the header for the ASC Sub-Board Listings
  241.      SUBLIST.CLR  - This is the color config for the Sub-Board Listings
  242.  
  243.      LIBLIST.RIP  - This is the background for the RIP File Libraries Listing
  244.      LIBLIST.ASC  - This is the header for the ASC File Libraries Listing
  245.      LIBLIST.CLR  - This is the color config for the File Libraries Listing
  246.      
  247.      DIRLIST.RIP  - This is the background for the RIP File Directory Listings
  248.      DIRLIST.ASC  - This is the header for the ASC File Directory Listings
  249.      DIRLIST.CLR  - This is the color config for the File Directory Listings
  250.  
  251.      XTRNSECS.RIP - This is the background for the RIP External Sections List
  252.      XTRNSECS.ASC - This is the header for the ASC External Sections List
  253.      XTRNSECS.CLR - This is the color config for the External Sections List
  254.      
  255.      XTRNLIST.RIP - This is the background for the RIP External Programs Lists
  256.      XTRNLIST.ASC - This is the header for the ASC External Programs Listings
  257.      XTRNLIST.CLR - This is the color config for the External Programs Listings
  258.  
  259.      TEXTSECS.RIP - This is the background for the RIP Text Sections Listing
  260.      TEXTSECS.ASC - This is the header for the ASC Text Sections Listing
  261.      TEXTSECS.CLR - This is the color config for the Text Sections Listing
  262.      
  263.      TEXTLIST.RIP - This is the background for the RIP Text File Listing
  264.      TEXTLIST.ASC - This is the header for the ASC Text File Listing
  265.      TEXTLIST.CLR - This is the color config for the Text File Listing
  266.      
  267.      As you can see there are many files that you can create to cusomize
  268.      RIP It! if you choose to do so.  The RIP backgrounds can be anything
  269.      that you wish to use.  RIP It! will write the menu items and labels over
  270.      the background that you use,  this is why I included the option to
  271.      force column output.  This will allow the minimum amount of your
  272.      background to be covered by the menu items.  The ASC header files are
  273.      not used as a background, but are displayed as a header before the 
  274.      menuitems are listed.  This allows you to customize the listings.
  275.  
  276.  
  277. ┌───────────────────────────────────────────────────────────────────────────┐
  278. │                           DEMO Restrictions                               │
  279. └───────────────────────────────────────────────────────────────────────────┘
  280.  
  281.      The Demo version of RIP It! is limited in a few ways.  This is very
  282.      frankly done to encourage registration of this product.  When you 
  283.      consider how much time RIP It! can save you and how much nicer your
  284.      board will look, the registration cost is very reasonable.
  285.  
  286.      The Demo version of RIP It! will ONLY create the menus for the Message
  287.      Groups (GRPS.RIP and GRPS.ASC) and all of the sub-boards (SUBSx.RIP 
  288.      and SUBSx.ASC).  You may customize all of the colors for these menus,
  289.      except an UNREGISTERED tagline will be added to the end of each menu 
  290.      and you may not change the color of this tagline.
  291.  
  292.      The Demo version will ignore ALL custom RIP background files and ASC
  293.      header files.  The Default backgrounds and headers are hard coded into
  294.      the program, but I have included the files BACKGRND.RIP and HEADER.ASC
  295.      so you can see what is being used internally.  Editing these files will
  296.      not allow you to customize your menus.
  297.  
  298.  
  299. ┌───────────────────────────────────────────────────────────────────────────┐
  300. │                    Registration and technical support                     │
  301. └───────────────────────────────────────────────────────────────────────────┘
  302.  
  303.     Registration cost is $20.00 U.S. for RIP It!.  The fee will be 
  304.     used to help me develop larger and better Synchronet programs.  
  305.     
  306.     Print the file REGISTER.DOC, fill it out and send it along with a 
  307.     check or money order for $20.00 U.S. to:
  308.  
  309.         Gregory Campbell
  310.         G.A.C. Computer Services
  311.         2040 Spring Creek Parkway Suite 141238
  312.         Plano, TX 75023-4225
  313.  
  314.     If you would like more information on how to use RIP It! or have 
  315.     a problem with it, you may contact me in the following ways.
  316.  
  317.      Call me voice:             214-517-3692 (10am-10pm CST)
  318.      Call my BBS:               214-527-6811
  319.      Send me NetMail:           Gregory Campbell@1:124/8047
  320.      Send me Internet E-mail:   Gregory.Campbell@f8047.n124.z1.fidonet.org
  321.      Send me QWK NetMail:       The.Tramp@DOGHOUSE
  322.  
  323.      Or Ask me a question in DOVE-Net, my Alias is The.Tramp
  324.  
  325.     To obtain the newest public release versions of RIP It!
  326.     FREQ RIPIT! from 1:124/8047 or call my BBS and login as Guest
  327.  
  328. ┌───────────────────────────────────────────────────────────────────────────┐
  329. │                           Known Anomolies                                 │
  330. └───────────────────────────────────────────────────────────────────────────┘
  331.  
  332.      - 4DOS Users should eliminate the white space in RIP_IT.CFG between
  333.        the option and the semi-colon.  This is a problem with 4 DOS not
  334.        correctly implementing the ANSI C standard.
  335.     
  336.         e.g. hb;Registration Information      (ASC)
  337.  
  338.      - RIP Paint (and most other paint programs) does not display the 
  339.        registration information or title correctly.  This is a problem with 
  340.        RIP Paint not supporting the RIP Text command (|T<text>).  The menus 
  341.        will display correctly to remote users.
  342.  
  343.  
  344.